home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1999 #2 / Amiga Plus CD - 1999 - No. 2.iso / System-Boost / Sound / GCSound / GCSound.readme < prev    next >
Encoding:
Text File  |  1998-11-12  |  4.5 KB  |  138 lines
  1. Short    : ARexx driven 8SVX player (+source)
  2. Uploader : dck@hol.gr (D. Keletsekis)
  3. Author   : dck@hol.gr (D. Keletsekis)
  4. Type     : mus/play
  5. Version  : 1.0
  6. Requires : WB 2+
  7.  
  8.    ==========================================================
  9.    >>>>> GCSound - 8SVX sample player
  10.    ==========================================================
  11.  
  12.    GCSound is a 8SVX sample player which can be controlled
  13.    from Gui4Cli (v3.6+) or from an ARexx program.
  14.  
  15.    You just run it, without any arguments (at the moment) and
  16.    it will load itself, create a public message port named 
  17.    "gcsound" (note the lower case) and sit around waiting for 
  18.    Gui4Cli or ARexx messages.
  19.  
  20.    Many samples can be loaded and played at will. If the sample
  21.    size is over 64k, it will be played directly from the hard
  22.    drive. You can have as many samples as you want loaded (note
  23.    that they will consume *chip* memory - maximum 64k each) and 
  24.    play up to 4 of them simuiltaneously.
  25.  
  26.    These are the commands it will understand :
  27.  
  28.    *       LOAD    <SampleFile> <Alias>
  29.  
  30.    Will load the sample into memory. <SampleFile> must be the
  31.    full path and file name of the sample, and <Alias> is a name
  32.    you give to it with which you can refer to it in other
  33.    commands. This could be the plain file name for example.
  34.    If the sample is over 64k, only the first 64k will be loaded.
  35.    The rest will be read from disk when needed.
  36.  
  37.    ex:
  38.    Address "gcsound"
  39.    'Load DH0:samples/mysample mysample'
  40.  
  41.    *       PLAY    <alias> [<times/0> <volume> <speed/-1>]
  42.  
  43.    This command will start to play an already loaded sample.
  44.    <Alias> is the name you gave to the sample. 
  45.  
  46.    You may also give the <times> you want it played (note 0 means 
  47.    - play forever), the <volume> (1-64) and the speed (125 - 1000
  48.    or -1 for default speed). If you don't give these, the sample 
  49.    will be played forever, at it's default volume and speed.
  50.  
  51.    *       UNLOAD  <alias/"">
  52.  
  53.    Will unload a loaded sample, freeing it's memory. If it's
  54.    playing, it will be aborted. If you do not give a sample name
  55.    then *all* samples will be aborted and unloaded.
  56.  
  57.    *       STOP    <alias/"">
  58.  
  59.    Will stop the given sample, if it's playing. Again, if you do
  60.    not give a sample name *all* samples currently playing will be 
  61.    stopped.
  62.  
  63.    *       SOUND   <SampleFile> [<times/0> <volume> <speed/-1>]
  64.  
  65.    This is like the Load and Play commands combined. It will
  66.    load the given <SampleFile> (full path), play it and when
  67.    finished, unload it.
  68.  
  69.    *       VOLUME  <alias> <1-64>
  70.  
  71.    With this you can change the volume of a loaded sample. 
  72.    This can also be done while the sample is being played.
  73.  
  74.    *       SPEED   <alias> <125-1000>
  75.  
  76.    Changes the speed of a loaded sample (while playing or not).
  77.  
  78.    *       TIMES   <alias> <times/0>
  79.  
  80.    Changes the times that a loaded sample will be played. 
  81.    Currently, this only works for large samples (i.e. the
  82.    ones being played directly from the hard drive)
  83.    Note that 0 means forever.
  84.  
  85.    *       QUIT
  86.  
  87.    Will abort all samples playing, unload everything and
  88.    quit.
  89.  
  90.    *       INFO    <alias>
  91.  
  92.    This command will return 2 numbers : the volume and the
  93.    speed of the given sample. From Gui4Cli, this can be accessed
  94.    through the $$Call.ret or $$RexxRet internal variables
  95.    depending on whether you used Call or SendRexx.
  96.  
  97.    If sent from an actual ARexx program, they will be stored
  98.    in arexx's RESULT variable.
  99.  
  100.    ==========================================================
  101.  
  102.    Behaviour :
  103.  
  104.    GCSound uses a user count system so that it may be accessed
  105.    by many outside programs. When you start up the program, it
  106.    will check if it's already running (i.e. if the gcsound port
  107.    exists) and if it is it will send it a message to increase 
  108.    the users counter.
  109.  
  110.    When you send it a quit command, it will decrease the users 
  111.    counter and will *not* quit until all other programs using it 
  112.    it have also told it to quit.
  113.  
  114.    This means that for each time you run the program you must
  115.    also send a respective quit command. You may get it stranded 
  116.    sometimes by running it too many times.. - just send it quit 
  117.    commands until you get a "host environment not found" error..
  118.    
  119.    Note :
  120.    
  121.    GCSound only plays mono samples at the moment. Stereo may
  122.    be added later..
  123.  
  124.    ==========================================================
  125.  
  126.    Author    D. Keletsekis 
  127.    Email    dck@hol.gr
  128.    WWW        http:users.hol.gr/~dck/gcmain.htm
  129.    Status    FreeWare
  130.    Date        October 98
  131.    
  132.    ==========================================================
  133.  
  134.  
  135.  
  136.  
  137.  
  138.